Managing Data Tables

A variety of workflow components can be used to search for data within custom tables. Data Tables are used to manage large amounts of data with optional settings for language and effective periods, allowing lookups to retrieve specific versions of the data.

The data table configuration sets the parameters of the data. Excel files containing the data are then uploaded to Instances of the table, with the specific settings to define when that data should be used. For additional information, see the Managing Data Table Instances section.

The data table configuration can be updated when necessary. For additional information, see the Editing a Data Table Configuration section.

Note: These instructions are for the Data Tables management section within the Workflow Containers. For details on the legacy version of the feature, please refer to the documentation for version 2.5.112 or earlier.

  1. Open the appropriate Workflow Container. For instructions on finding and opening a container, see the section on Managing Workflow Containers.
  2. In the Workflow Container Menu widget, open the Lookups group and select Data Tables. The Data Tables page opens with a list of all available data tables within the current container and any shared containers.
  3. Tip: By default, only Active data tables are displayed.  Clear the filter in the Status column to view all tables.

    If there are a large number of available data tables, see the Using Grids section for help on finding the appropriate tables.

  4. Select an action.
    • Click a link in the Name column to view an existing data table.
    • Click Add to add a new data table.
  5. On viewing or creating a data table, the DataTable Management page opens.
  6. The panels and fields are described below.  Fields marked with a red asterisk * are required.
  7. Name

    Enter the name of the table.

    Code

    This is an internal reference code.  A code can be entered manually, or leave the field blank to have the system generate a code on saving.

    Description A description can be provided for the table. This information is only displayed here in the Data Table Management page.

    Table

    This field is used to upload a sample Excel file to define the columns.  Click the button in the field to open a standard file browser window.  Locate and select the appropriate file, and the file name and path appear in the field.

     

    Only the first row of the first sheet is imported, with all other data ignored.  Any unnamed columns appearing before the last named column will be imported and generic column names will be assigned.

     

    Example:  

    Importing the above sheet would create the following columns:

    Upload Columns

    Click Upload Columns to import the selected Table file.  The columns defined in the file will populate the Key Columns field, Sorting Column list, and the Columns grid below.

    Key Columns

    Select which columns will serve as key columns.  All key columns must be required data, and a combination of all key columns must uniquely identify individual entries in the table.

    This field becomes read-only once the table is saved.

    Sorting Column

    A column can be selected to serve as sorting or sequence values.  The selected column will not be available for use as a Primary Display Column or Key Column in a Data Source Configuration.

    The Columns grid displays all columns included in the table, and the sequence as they appear in the source file.

    The Data Table Instances panel becomes available once the current data table configuration has been saved.

    This panel lists all instances included in the current data table, and is used to manage the instances. See the Managing Data Table Instances section for detailed instructions.

    The Status panel becomes available once the current data table configuration has been saved.

    Active Marks the panel as active and available for use. Inactive panels will still be functional in existing configurations, but cannot be selected for new configurations.

    Created By

    Identifies the date and time the data table was created, and the user who created it.

    Last Modified By

    Identifies the last date and time the data table was changed, and the user who made the changes. This does not include changes to data table instances.

  8. Select an action.
    • When creating the data table, click Save to save the table but remain on the page.
    • When creating the data table, click Save & Close to save the table and return to the data tables list.
    • Click Close to return to the data tables list without saving the table.

Managing Data Table Instances

The Data Table configuration contains general settings for the data table, while the Data Table Instances, also referred to as Domain / Rate Tables, contain the actual data. Each instance is defined with settings to determine which instance should be used when the data table is accessed, which can provide entirely different data based on those settings.

  1. Open the appropriate Workflow Container and Data Table configuration. For instructions, see the sections on Managing Workflow Containers and Data Tables.
  2. In the Data Table configuration, go to the Data Table Instances panel. This panel lists all instances within the current data table.
  3. Select an action.
    • Click a link in the Data Table Instance Name column to view an existing instance.
    • Click a link in the File Name column to view the original uploaded Excel file.
    • Click a link in the Download column to download the data from that instance into a new Excel file.
    • Click Add to add a new instance.
    • Check the boxes for one or more instances and click Delete to remove the selected instances and all associated data.
  4. On viewing or creating an instance, the Domain / Rate Table Management window opens.
  5. The panels and fields are described below.  Fields marked with a red asterisk * are required.

    Data Table

    Displays the name of the current data table. This field cannot be modified.

    Name

    Enter the name of the data table instance.

    Code

    This is an internal reference code that must be unique.  A code can be entered manually, or leave the field blank to have the system generate a code on saving.

    Description A description can be provided for the table. This information is only displayed here in the Data / Rate Table Management window.

    Culture

    An instance can be associated to a language, including a regional dialect. If no selection has been made, the data will not be culture-specific.  When the data table is accessed, the system will use the appropriate instance for the browser’s language settings.

    Effective Date

    A date can be specified for when this instance comes into effect.  The date can be entered manually or selected from the calendar lookup .  When the data table is accessed, the system will use the most recently uploaded table that corresponds to a specific date.

    Imported File Name

    Once a file has been uploaded, this field will display the file name.

    This field becomes read-only once the table is saved.

    Select File to Import

    Click the button in the field to open a standard file browser window.  Locate and select the appropriate file, and the file name and path appear in the field.

    Note:  

    Culture and Effective Date are used to define which instance will be used when the data table is accessed.

    • Instances are only valid on or after their effective date.  The system will identify all instances valid on the specified date.
    • Of the valid tables, the system will then check Culture settings for an exact match on both language and region.  If no match is found, the system will then check for a match on just language.  If no match on language alone is found, the system will then check for instances where no Culture is selected.
    • If multiple instances are valid on both Effective Date and Culture, the system will use the one most recently uploaded.
    • If no valid instances are found, the system will not return any result.

    The columns and column labels in the uploaded file must match the sample file uploaded to the selected Data Table.  If not, the file upload will be rejected and an error will be displayed.

    The Status panel becomes available once the current data table instance has been saved.

    Created By

    Identifies the date and time the instance was created, and the user who created it.

    Last Modified By

    Identifies the last date and time the instance was changed, and the user who made the changes.

  6. Select an action.
    • Click Save to save the instance and keep the window open. When saving, any file chosen to be uploaded will be automatically imported.
    • Click Close to close the window without saving the instance.

Editing a Data Table Configuration

The Data Table configuration can be updated when necessary. This includes the re-naming of the table, uploading a new column configuration, or updating the Key Columns or Sorting Column. Note that existing Data Table Instances must be deleted before changes are made to core table properties.

  1. Open the appropriate Workflow Container. For instructions on finding and opening a container, see the section on Managing Workflow Containers.
  2. In the Workflow Container Menu widget, open the Lookups group and select Data Tables. The Data Tables page opens with a list of all available data tables within the current container and any shared containers.
  3. Tip: By default, only Active data tables are displayed.  Clear the filter in the Status column to view all tables.

  4. Click the link in the Name column to view and edit an existing data table. The Data Table Management page opens. See the section on Managing Data Tables for a detailed description of the fields.

  5. Navigate to the Attributes panel and apply the necessary changes to the table configuration. The following changes are supported.

    • Making changes to the Name or Description fields.
    • Uploading a new column structure. This includes adding or deleting columns, changing column names, or re-ordering existing columns.
    • Marking the Data Table as Inactive by unchecking the Active checkbox in the Status panel. Inactive tables will still be functional in existing configurations, but cannot be selected for new configurations.

    Note: When adding or deleting columns, changing column names, re-ordering existing columns, or modifying Key Columns, existing Data Table Instances structured with the previous table configuration must be deleted. To mitigate any potential loss of data, Data Table Instances can be downloaded prior to updating the table columns.

    Before accepting a new table configuration, the system verifies whether any altered columns are used in an active Data Source configuration. If a dependency is identified, the system returns an error message and prevents the upload. The Data Source configuration must be modified before the columns can be successfully uploaded.